home *** CD-ROM | disk | FTP | other *** search
/ Mac Easy 2010 May / Mac Life Ubuntu.iso / casper / filesystem.squashfs / usr / lib / python2.6 / distutils / util.py < prev    next >
Encoding:
Python Source  |  2009-04-18  |  20.3 KB  |  550 lines
  1. """distutils.util
  2.  
  3. Miscellaneous utility functions -- anything that doesn't fit into
  4. one of the other *util.py modules.
  5. """
  6.  
  7. __revision__ = "$Id: util.py 68135 2009-01-01 15:46:10Z georg.brandl $"
  8.  
  9. import sys, os, string, re
  10. from distutils.errors import DistutilsPlatformError
  11. from distutils.dep_util import newer
  12. from distutils.spawn import spawn
  13. from distutils import log
  14.  
  15. def get_platform ():
  16.     """Return a string that identifies the current platform.  This is used
  17.     mainly to distinguish platform-specific build directories and
  18.     platform-specific built distributions.  Typically includes the OS name
  19.     and version and the architecture (as supplied by 'os.uname()'),
  20.     although the exact information included depends on the OS; eg. for IRIX
  21.     the architecture isn't particularly important (IRIX only runs on SGI
  22.     hardware), but for Linux the kernel version isn't particularly
  23.     important.
  24.  
  25.     Examples of returned values:
  26.        linux-i586
  27.        linux-alpha (?)
  28.        solaris-2.6-sun4u
  29.        irix-5.3
  30.        irix64-6.2
  31.  
  32.     Windows will return one of:
  33.        win-amd64 (64bit Windows on AMD64 (aka x86_64, Intel64, EM64T, etc)
  34.        win-ia64 (64bit Windows on Itanium)
  35.        win32 (all others - specifically, sys.platform is returned)
  36.  
  37.     For other non-POSIX platforms, currently just returns 'sys.platform'.
  38.     """
  39.     if os.name == 'nt':
  40.         # sniff sys.version for architecture.
  41.         prefix = " bit ("
  42.         i = string.find(sys.version, prefix)
  43.         if i == -1:
  44.             return sys.platform
  45.         j = string.find(sys.version, ")", i)
  46.         look = sys.version[i+len(prefix):j].lower()
  47.         if look=='amd64':
  48.             return 'win-amd64'
  49.         if look=='itanium':
  50.             return 'win-ia64'
  51.         return sys.platform
  52.  
  53.     if os.name != "posix" or not hasattr(os, 'uname'):
  54.         # XXX what about the architecture? NT is Intel or Alpha,
  55.         # Mac OS is M68k or PPC, etc.
  56.         return sys.platform
  57.  
  58.     # Try to distinguish various flavours of Unix
  59.  
  60.     (osname, host, release, version, machine) = os.uname()
  61.  
  62.     # Convert the OS name to lowercase, remove '/' characters
  63.     # (to accommodate BSD/OS), and translate spaces (for "Power Macintosh")
  64.     osname = string.lower(osname)
  65.     osname = string.replace(osname, '/', '')
  66.     machine = string.replace(machine, ' ', '_')
  67.     machine = string.replace(machine, '/', '-')
  68.  
  69.     if osname[:5] == "linux":
  70.         # At least on Linux/Intel, 'machine' is the processor --
  71.         # i386, etc.
  72.         # XXX what about Alpha, SPARC, etc?
  73.         return  "%s-%s" % (osname, machine)
  74.     elif osname[:5] == "sunos":
  75.         if release[0] >= "5":           # SunOS 5 == Solaris 2
  76.             osname = "solaris"
  77.             release = "%d.%s" % (int(release[0]) - 3, release[2:])
  78.         # fall through to standard osname-release-machine representation
  79.     elif osname[:4] == "irix":              # could be "irix64"!
  80.         return "%s-%s" % (osname, release)
  81.     elif osname[:3] == "aix":
  82.         return "%s-%s.%s" % (osname, version, release)
  83.     elif osname[:6] == "cygwin":
  84.         osname = "cygwin"
  85.         rel_re = re.compile (r'[\d.]+')
  86.         m = rel_re.match(release)
  87.         if m:
  88.             release = m.group()
  89.     elif osname[:6] == "darwin":
  90.         #
  91.         # For our purposes, we'll assume that the system version from
  92.         # distutils' perspective is what MACOSX_DEPLOYMENT_TARGET is set
  93.         # to. This makes the compatibility story a bit more sane because the
  94.         # machine is going to compile and link as if it were
  95.         # MACOSX_DEPLOYMENT_TARGET.
  96.         from distutils.sysconfig import get_config_vars
  97.         cfgvars = get_config_vars()
  98.  
  99.         macver = os.environ.get('MACOSX_DEPLOYMENT_TARGET')
  100.         if not macver:
  101.             macver = cfgvars.get('MACOSX_DEPLOYMENT_TARGET')
  102.  
  103.         if 1:
  104.             # Always calculate the release of the running machine,
  105.             # needed to determine if we can build fat binaries or not.
  106.  
  107.             macrelease = macver
  108.             # Get the system version. Reading this plist is a documented
  109.             # way to get the system version (see the documentation for
  110.             # the Gestalt Manager)
  111.             try:
  112.                 f = open('/System/Library/CoreServices/SystemVersion.plist')
  113.             except IOError:
  114.                 # We're on a plain darwin box, fall back to the default
  115.                 # behaviour.
  116.                 pass
  117.             else:
  118.                 m = re.search(
  119.                         r'<key>ProductUserVisibleVersion</key>\s*' +
  120.                         r'<string>(.*?)</string>', f.read())
  121.                 f.close()
  122.                 if m is not None:
  123.                     macrelease = '.'.join(m.group(1).split('.')[:2])
  124.                 # else: fall back to the default behaviour
  125.  
  126.         if not macver:
  127.             macver = macrelease
  128.  
  129.         if macver:
  130.             from distutils.sysconfig import get_config_vars
  131.             release = macver
  132.             osname = "macosx"
  133.  
  134.             if (macrelease + '.') >= '10.4.' and \
  135.                     '-arch' in get_config_vars().get('CFLAGS', '').strip():
  136.                 # The universal build will build fat binaries, but not on
  137.                 # systems before 10.4
  138.                 #
  139.                 # Try to detect 4-way universal builds, those have machine-type
  140.                 # 'universal' instead of 'fat'.
  141.  
  142.                 machine = 'fat'
  143.                 cflags = get_config_vars().get('CFLAGS')
  144.  
  145.                 if '-arch x86_64' in cflags:
  146.                     if '-arch i386' in cflags:
  147.                         machine = 'universal'
  148.                     else:
  149.                         machine = 'fat64'
  150.  
  151.             elif machine in ('PowerPC', 'Power_Macintosh'):
  152.                 # Pick a sane name for the PPC architecture.
  153.                 machine = 'ppc'
  154.  
  155.     return "%s-%s-%s" % (osname, release, machine)
  156.  
  157. # get_platform ()
  158.  
  159.  
  160. def convert_path (pathname):
  161.     """Return 'pathname' as a name that will work on the native filesystem,
  162.     i.e. split it on '/' and put it back together again using the current
  163.     directory separator.  Needed because filenames in the setup script are
  164.     always supplied in Unix style, and have to be converted to the local
  165.     convention before we can actually use them in the filesystem.  Raises
  166.     ValueError on non-Unix-ish systems if 'pathname' either starts or
  167.     ends with a slash.
  168.     """
  169.     if os.sep == '/':
  170.         return pathname
  171.     if not pathname:
  172.         return pathname
  173.     if pathname[0] == '/':
  174.         raise ValueError, "path '%s' cannot be absolute" % pathname
  175.     if pathname[-1] == '/':
  176.         raise ValueError, "path '%s' cannot end with '/'" % pathname
  177.  
  178.     paths = string.split(pathname, '/')
  179.     while '.' in paths:
  180.         paths.remove('.')
  181.     if not paths:
  182.         return os.curdir
  183.     return apply(os.path.join, paths)
  184.  
  185. # convert_path ()
  186.  
  187.  
  188. def change_root (new_root, pathname):
  189.     """Return 'pathname' with 'new_root' prepended.  If 'pathname' is
  190.     relative, this is equivalent to "os.path.join(new_root,pathname)".
  191.     Otherwise, it requires making 'pathname' relative and then joining the
  192.     two, which is tricky on DOS/Windows and Mac OS.
  193.     """
  194.     if os.name == 'posix':
  195.         if not os.path.isabs(pathname):
  196.             return os.path.join(new_root, pathname)
  197.         else:
  198.             return os.path.join(new_root, pathname[1:])
  199.  
  200.     elif os.name == 'nt':
  201.         (drive, path) = os.path.splitdrive(pathname)
  202.         if path[0] == '\\':
  203.             path = path[1:]
  204.         return os.path.join(new_root, path)
  205.  
  206.     elif os.name == 'os2':
  207.         (drive, path) = os.path.splitdrive(pathname)
  208.         if path[0] == os.sep:
  209.             path = path[1:]
  210.         return os.path.join(new_root, path)
  211.  
  212.     elif os.name == 'mac':
  213.         if not os.path.isabs(pathname):
  214.             return os.path.join(new_root, pathname)
  215.         else:
  216.             # Chop off volume name from start of path
  217.             elements = string.split(pathname, ":", 1)
  218.             pathname = ":" + elements[1]
  219.             return os.path.join(new_root, pathname)
  220.  
  221.     else:
  222.         raise DistutilsPlatformError, \
  223.               "nothing known about platform '%s'" % os.name
  224.  
  225.  
  226. _environ_checked = 0
  227. def check_environ ():
  228.     """Ensure that 'os.environ' has all the environment variables we
  229.     guarantee that users can use in config files, command-line options,
  230.     etc.  Currently this includes:
  231.       HOME - user's home directory (Unix only)
  232.       PLAT - description of the current platform, including hardware
  233.              and OS (see 'get_platform()')
  234.     """
  235.     global _environ_checked
  236.     if _environ_checked:
  237.         return
  238.  
  239.     if os.name == 'posix' and 'HOME' not in os.environ:
  240.         import pwd
  241.         os.environ['HOME'] = pwd.getpwuid(os.getuid())[5]
  242.  
  243.     if 'PLAT' not in os.environ:
  244.         os.environ['PLAT'] = get_platform()
  245.  
  246.     _environ_checked = 1
  247.  
  248.  
  249. def subst_vars (s, local_vars):
  250.     """Perform shell/Perl-style variable substitution on 'string'.  Every
  251.     occurrence of '$' followed by a name is considered a variable, and
  252.     variable is substituted by the value found in the 'local_vars'
  253.     dictionary, or in 'os.environ' if it's not in 'local_vars'.
  254.     'os.environ' is first checked/augmented to guarantee that it contains
  255.     certain values: see 'check_environ()'.  Raise ValueError for any
  256.     variables not found in either 'local_vars' or 'os.environ'.
  257.     """
  258.     check_environ()
  259.     def _subst (match, local_vars=local_vars):
  260.         var_name = match.group(1)
  261.         if var_name in local_vars:
  262.             return str(local_vars[var_name])
  263.         else:
  264.             return os.environ[var_name]
  265.  
  266.     try:
  267.         return re.sub(r'\$([a-zA-Z_][a-zA-Z_0-9]*)', _subst, s)
  268.     except KeyError, var:
  269.         raise ValueError, "invalid variable '$%s'" % var
  270.  
  271. # subst_vars ()
  272.  
  273.  
  274. def grok_environment_error (exc, prefix="error: "):
  275.     """Generate a useful error message from an EnvironmentError (IOError or
  276.     OSError) exception object.  Handles Python 1.5.1 and 1.5.2 styles, and
  277.     does what it can to deal with exception objects that don't have a
  278.     filename (which happens when the error is due to a two-file operation,
  279.     such as 'rename()' or 'link()'.  Returns the error message as a string
  280.     prefixed with 'prefix'.
  281.     """
  282.     # check for Python 1.5.2-style {IO,OS}Error exception objects
  283.     if hasattr(exc, 'filename') and hasattr(exc, 'strerror'):
  284.         if exc.filename:
  285.             error = prefix + "%s: %s" % (exc.filename, exc.strerror)
  286.         else:
  287.             # two-argument functions in posix module don't
  288.             # include the filename in the exception object!
  289.             error = prefix + "%s" % exc.strerror
  290.     else:
  291.         error = prefix + str(exc[-1])
  292.  
  293.     return error
  294.  
  295.  
  296. # Needed by 'split_quoted()'
  297. _wordchars_re = _squote_re = _dquote_re = None
  298. def _init_regex():
  299.     global _wordchars_re, _squote_re, _dquote_re
  300.     _wordchars_re = re.compile(r'[^\\\'\"%s ]*' % string.whitespace)
  301.     _squote_re = re.compile(r"'(?:[^'\\]|\\.)*'")
  302.     _dquote_re = re.compile(r'"(?:[^"\\]|\\.)*"')
  303.  
  304. def split_quoted (s):
  305.     """Split a string up according to Unix shell-like rules for quotes and
  306.     backslashes.  In short: words are delimited by spaces, as long as those
  307.     spaces are not escaped by a backslash, or inside a quoted string.
  308.     Single and double quotes are equivalent, and the quote characters can
  309.     be backslash-escaped.  The backslash is stripped from any two-character
  310.     escape sequence, leaving only the escaped character.  The quote
  311.     characters are stripped from any quoted string.  Returns a list of
  312.     words.
  313.     """
  314.  
  315.     # This is a nice algorithm for splitting up a single string, since it
  316.     # doesn't require character-by-character examination.  It was a little
  317.     # bit of a brain-bender to get it working right, though...
  318.     if _wordchars_re is None: _init_regex()
  319.  
  320.     s = string.strip(s)
  321.     words = []
  322.     pos = 0
  323.  
  324.     while s:
  325.         m = _wordchars_re.match(s, pos)
  326.         end = m.end()
  327.         if end == len(s):
  328.             words.append(s[:end])
  329.             break
  330.  
  331.         if s[end] in string.whitespace: # unescaped, unquoted whitespace: now
  332.             words.append(s[:end])       # we definitely have a word delimiter
  333.             s = string.lstrip(s[end:])
  334.             pos = 0
  335.  
  336.         elif s[end] == '\\':            # preserve whatever is being escaped;
  337.                                         # will become part of the current word
  338.             s = s[:end] + s[end+1:]
  339.             pos = end+1
  340.  
  341.         else:
  342.             if s[end] == "'":           # slurp singly-quoted string
  343.                 m = _squote_re.match(s, end)
  344.             elif s[end] == '"':         # slurp doubly-quoted string
  345.                 m = _dquote_re.match(s, end)
  346.             else:
  347.                 raise RuntimeError, \
  348.                       "this can't happen (bad char '%c')" % s[end]
  349.  
  350.             if m is None:
  351.                 raise ValueError, \
  352.                       "bad string (mismatched %s quotes?)" % s[end]
  353.  
  354.             (beg, end) = m.span()
  355.             s = s[:beg] + s[beg+1:end-1] + s[end:]
  356.             pos = m.end() - 2
  357.  
  358.         if pos >= len(s):
  359.             words.append(s)
  360.             break
  361.  
  362.     return words
  363.  
  364. # split_quoted ()
  365.  
  366.  
  367. def execute (func, args, msg=None, verbose=0, dry_run=0):
  368.     """Perform some action that affects the outside world (eg.  by
  369.     writing to the filesystem).  Such actions are special because they
  370.     are disabled by the 'dry_run' flag.  This method takes care of all
  371.     that bureaucracy for you; all you have to do is supply the
  372.     function to call and an argument tuple for it (to embody the
  373.     "external action" being performed), and an optional message to
  374.     print.
  375.     """
  376.     if msg is None:
  377.         msg = "%s%r" % (func.__name__, args)
  378.         if msg[-2:] == ',)':        # correct for singleton tuple
  379.             msg = msg[0:-2] + ')'
  380.  
  381.     log.info(msg)
  382.     if not dry_run:
  383.         apply(func, args)
  384.  
  385.  
  386. def strtobool (val):
  387.     """Convert a string representation of truth to true (1) or false (0).
  388.  
  389.     True values are 'y', 'yes', 't', 'true', 'on', and '1'; false values
  390.     are 'n', 'no', 'f', 'false', 'off', and '0'.  Raises ValueError if
  391.     'val' is anything else.
  392.     """
  393.     val = string.lower(val)
  394.     if val in ('y', 'yes', 't', 'true', 'on', '1'):
  395.         return 1
  396.     elif val in ('n', 'no', 'f', 'false', 'off', '0'):
  397.         return 0
  398.     else:
  399.         raise ValueError, "invalid truth value %r" % (val,)
  400.  
  401.  
  402. def byte_compile (py_files,
  403.                   optimize=0, force=0,
  404.                   prefix=None, base_dir=None,
  405.                   verbose=1, dry_run=0,
  406.                   direct=None):
  407.     """Byte-compile a collection of Python source files to either .pyc
  408.     or .pyo files in the same directory.  'py_files' is a list of files
  409.     to compile; any files that don't end in ".py" are silently skipped.
  410.     'optimize' must be one of the following:
  411.       0 - don't optimize (generate .pyc)
  412.       1 - normal optimization (like "python -O")
  413.       2 - extra optimization (like "python -OO")
  414.     If 'force' is true, all files are recompiled regardless of
  415.     timestamps.
  416.  
  417.     The source filename encoded in each bytecode file defaults to the
  418.     filenames listed in 'py_files'; you can modify these with 'prefix' and
  419.     'basedir'.  'prefix' is a string that will be stripped off of each
  420.     source filename, and 'base_dir' is a directory name that will be
  421.     prepended (after 'prefix' is stripped).  You can supply either or both
  422.     (or neither) of 'prefix' and 'base_dir', as you wish.
  423.  
  424.     If 'dry_run' is true, doesn't actually do anything that would
  425.     affect the filesystem.
  426.  
  427.     Byte-compilation is either done directly in this interpreter process
  428.     with the standard py_compile module, or indirectly by writing a
  429.     temporary script and executing it.  Normally, you should let
  430.     'byte_compile()' figure out to use direct compilation or not (see
  431.     the source for details).  The 'direct' flag is used by the script
  432.     generated in indirect mode; unless you know what you're doing, leave
  433.     it set to None.
  434.     """
  435.  
  436.     # First, if the caller didn't force us into direct or indirect mode,
  437.     # figure out which mode we should be in.  We take a conservative
  438.     # approach: choose direct mode *only* if the current interpreter is
  439.     # in debug mode and optimize is 0.  If we're not in debug mode (-O
  440.     # or -OO), we don't know which level of optimization this
  441.     # interpreter is running with, so we can't do direct
  442.     # byte-compilation and be certain that it's the right thing.  Thus,
  443.     # always compile indirectly if the current interpreter is in either
  444.     # optimize mode, or if either optimization level was requested by
  445.     # the caller.
  446.     if direct is None:
  447.         direct = (__debug__ and optimize == 0)
  448.  
  449.     # "Indirect" byte-compilation: write a temporary script and then
  450.     # run it with the appropriate flags.
  451.     if not direct:
  452.         try:
  453.             from tempfile import mkstemp
  454.             (script_fd, script_name) = mkstemp(".py")
  455.         except ImportError:
  456.             from tempfile import mktemp
  457.             (script_fd, script_name) = None, mktemp(".py")
  458.         log.info("writing byte-compilation script '%s'", script_name)
  459.         if not dry_run:
  460.             if script_fd is not None:
  461.                 script = os.fdopen(script_fd, "w")
  462.             else:
  463.                 script = open(script_name, "w")
  464.  
  465.             script.write("""\
  466. from distutils.util import byte_compile
  467. files = [
  468. """)
  469.  
  470.             # XXX would be nice to write absolute filenames, just for
  471.             # safety's sake (script should be more robust in the face of
  472.             # chdir'ing before running it).  But this requires abspath'ing
  473.             # 'prefix' as well, and that breaks the hack in build_lib's
  474.             # 'byte_compile()' method that carefully tacks on a trailing
  475.             # slash (os.sep really) to make sure the prefix here is "just
  476.             # right".  This whole prefix business is rather delicate -- the
  477.             # problem is that it's really a directory, but I'm treating it
  478.             # as a dumb string, so trailing slashes and so forth matter.
  479.  
  480.             #py_files = map(os.path.abspath, py_files)
  481.             #if prefix:
  482.             #    prefix = os.path.abspath(prefix)
  483.  
  484.             script.write(string.join(map(repr, py_files), ",\n") + "]\n")
  485.             script.write("""
  486. byte_compile(files, optimize=%r, force=%r,
  487.              prefix=%r, base_dir=%r,
  488.              verbose=%r, dry_run=0,
  489.              direct=1)
  490. """ % (optimize, force, prefix, base_dir, verbose))
  491.  
  492.             script.close()
  493.  
  494.         cmd = [sys.executable, script_name]
  495.         if optimize == 1:
  496.             cmd.insert(1, "-O")
  497.         elif optimize == 2:
  498.             cmd.insert(1, "-OO")
  499.         spawn(cmd, dry_run=dry_run)
  500.         execute(os.remove, (script_name,), "removing %s" % script_name,
  501.                 dry_run=dry_run)
  502.  
  503.     # "Direct" byte-compilation: use the py_compile module to compile
  504.     # right here, right now.  Note that the script generated in indirect
  505.     # mode simply calls 'byte_compile()' in direct mode, a weird sort of
  506.     # cross-process recursion.  Hey, it works!
  507.     else:
  508.         from py_compile import compile
  509.  
  510.         for file in py_files:
  511.             if file[-3:] != ".py":
  512.                 # This lets us be lazy and not filter filenames in
  513.                 # the "install_lib" command.
  514.                 continue
  515.  
  516.             # Terminology from the py_compile module:
  517.             #   cfile - byte-compiled file
  518.             #   dfile - purported source filename (same as 'file' by default)
  519.             cfile = file + (__debug__ and "c" or "o")
  520.             dfile = file
  521.             if prefix:
  522.                 if file[:len(prefix)] != prefix:
  523.                     raise ValueError, \
  524.                           ("invalid prefix: filename %r doesn't start with %r"
  525.                            % (file, prefix))
  526.                 dfile = dfile[len(prefix):]
  527.             if base_dir:
  528.                 dfile = os.path.join(base_dir, dfile)
  529.  
  530.             cfile_base = os.path.basename(cfile)
  531.             if direct:
  532.                 if force or newer(file, cfile):
  533.                     log.info("byte-compiling %s to %s", file, cfile_base)
  534.                     if not dry_run:
  535.                         compile(file, cfile, dfile)
  536.                 else:
  537.                     log.debug("skipping byte-compilation of %s to %s",
  538.                               file, cfile_base)
  539.  
  540. # byte_compile ()
  541.  
  542. def rfc822_escape (header):
  543.     """Return a version of the string escaped for inclusion in an
  544.     RFC-822 header, by ensuring there are 8 spaces space after each newline.
  545.     """
  546.     lines = string.split(header, '\n')
  547.     lines = map(string.strip, lines)
  548.     header = string.join(lines, '\n' + 8*' ')
  549.     return header
  550.